FMS History Data Groups

FMS history data groups are used to send historical data to FMS. Multiple instances of an FMS History data group in a device template file are possible. They get their data from a support data group identified either by attribute type dgStruct="Archive" or attribute type dgStruct="ArrayHistory". The support data group must be defined and instantiated before polling an FmsHist data group.

Mapping between FMS history data group elements and FMS data items is within the histItems section of fmsMaps in the device template file. See also FMS History Data Items.

FMS history data groups use a maximum of 10 characters for their name, the first 7 of which characters must be FmsHist. The last 3 characters are entirely free-form. For example, FmsHistH could signify FMS hourly history.

The TmOrient data group element does not appear in a device template file, but it commonly appears as part of a DDS transaction in the CygNet DDS Viewer utility (DdsViewer.exe). This element indicates whether a device supplies history in leading or trailing time. If its value is 1, the history record uses leading time. If its value is 2, the history record uses trailing time. For BSAP FMS History data groups, the TmOrient element can be overridden in the device template file by using the leadingTime attribute.

For more information, see the following subsections:

For more information about working with device template files, see Device Template Files.

Example

<FmsHistHGm niceName="FMS Hourly PM History" baseOrd="1" maxCnt="12" recordMinutes="60" histType="GM">

<dgElements/>

<supportDg>

<HistArcH required="false"/>

<HistArrayH required="false"/>

</supportDg>

<uccRecvParms>

<SDate desc="Start Device Date/Time" required="true"/>

<EDate desc="End Device Date/Time" required="true"/>

</uccRecvParms>

</FmsHistHGm>

...

<HistArcH niceName="History - hourly archive" dgStruct="Archive" dgMaxEnt="840" maxCnt="4" dgStructNum_ord1="1" dgStructNum_ord2="4" dgStructNum_ord3="7" dgStructNum_ord4="10" canSend="false" leadingTime="false">

<dgElements type="vrnt">

<EntryCt desc="Entry Count" type="i2"/>

</dgElements>

</HistArcH>

...

<HistArrayH niceName="History - hourly array" dgStruct="ArrayHistory" canSend="false" maxCnt="1" baseOrd="3" devDG="false" ordLabel="Run#" dgStructNum_ord3="46" recordMinutes="60" isOldToNew="false" queueStart="2" currentIndex="2">

<dgElements type="vrnt">

<Index desc="Index" type="i2"/>

</dgElements>

</HistArrayH>

Structure and Components

<!-- To get FMS history, you must include both the histType and recordMinutes attributes along with their respective values. Either an Archive data group type (where dgStruct="Archive") or an Array History data group type (where dgStruct="ArrayHistory") can be identified as a support data group. -->

<FmsHist recordMinutes="" histType=""tmFormat="">

<dgElements/>

<supportDg>

<SupportDataGroup required="true"/>

</supportDg>

<uccRecvParms>

<UISParameter/>

</uccRecvParms>

</FmsHist>

To Create a Data Group

  1. Using a text editor or XML editor, open the device template file to which you want to add data groups.
  2. Define a new data group.
    1. Define a supportDg element.
    2. Define all support data groups from which you require data.
    3. Define a dgElements element.
    4. Define a uccRecvParms element in the data group.
    5. Define one or more RecParmName elements.
  3. Define any other required data groups.
  4. Validate and load your template.